After working with this more, I ran into an issue with VirtualBox not being able to create symlinks. I talked to Mat (@aepod) on our team and realized that I think everyone using this is using Macs. It might make more sense to not merge this PR and instead include a big notice at the top that this will not work on Windows until someone can confirm it working. My next step here is to build my own VM from our base vm. Mat already did this and it worked. I appreciate the work being done here still.

@kirkmadera It might be worth trying to start vagrant with administration rights (start your terminal with it). It helped me create symlinks. Probably doesn't work on Windows 10 tho.

@kirkmadera Thanks for your PR.

Could you please check if it works with administrator privileges as @stefandoorn mentioned?
If yes, could you please update your pull request and add an hint for Windows users?

I figured out that I had to run a couple of additional commands.

cd /vagrant/data/magento2;
git checkout master; # develop is the default branch and I wanted to work with more stable code
composer update;
cp ~/.composer/auth.json var/composer_home;
dos2unix bin/magento;
bin/magento sampledata:deploy;
bin/magento setup:upgrade;
bin/magento setup:static-content:deploy;

I think symlink creation would probably still be an issue, but deploying the assets makes it work.

I added enough notes for this to be sufficient for Windows users. I think this is safe to pull in.